
/*
 * Copyright (c) 2015-2022 Agalmic Ventures LLC (www.agalmicventures.com)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

#pragma once

#include <boost/interprocess/ipc/message_queue.hpp>
#include <unistd.h>

#include "Werk/Utility/Attributes.hpp"
#include "Werk/Utility/NamedObject.hpp"

namespace werk
{

/**
 * A console client that use interprocess queues to send messages.
 */
class IpcConsoleClient : public NamedObject
{
public:
	IpcConsoleClient(const std::string &name) :
		NamedObject(name),
		_queue(boost::interprocess::open_only, name.c_str()),
		_pid(getpid()) {
		//Send a heartbeat to let the server know about the connection
		//The return value of this one is ignored (and the ! is
		//necessary for some compilers to not warn).
		(void) !heartbeat();
	}

	CHECKED bool send(const std::string &message);
	CHECKED bool heartbeat() { return send(""); }

private:
	boost::interprocess::message_queue _queue;

	uint64_t _pid = 0;
	uint32_t _nextSequenceNumber = 0;
};

}
